Vcenter Ovf IpAllocationParams

The Vcenter Ovf IpAllocationParams schema specifies how IP addresses are allocated to OVF properties. In particular, it informs the deployment platform whether the guest supports IPv4, IPv6, or both. It also specifies whether the IP addresses can be obtained through DHCP or through the properties provided in the OVF environment.

Ovf Property elements are exposed to the guest software through the OVF environment. Each Property element exposed in the OVF environment shall be constructed from the value of the ovf:key attribute. A Property element contains a key/value pair, it may optionally specify type qualifiers using the ovf:qualifiers attribute with multiple qualifiers separated by commas.

The settings in Vcenter Ovf IpAllocationParams schema are global to a deployment. Thus, if a virtual machine is part of a virtual appliance, then its settings are ignored and the settings for the virtual appliance is used.

This information is based on the vmw:IpAssignmentSection in OVF package.

See POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=deploy and POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=filter.

JSON Example

{
    "supported_allocation_scheme": [
        "string"
    ],
    "supported_ip_allocation_policy": [
        "string"
    ],
    "ip_allocation_policy": "string",
    "supported_ip_protocol": [
        "string"
    ],
    "ip_protocol": "string",
    "type": "string"
}

array of string

supported_allocation_scheme

Optional

Specifies the IP allocation schemes supported by the guest software. This property defines the valid values for the IP allocation policy. This setting is often configured by the virtual appliance template author or OVF package author to reflect what the guest software supports, and the IP allocation policy is configured at deployment time. See Vcenter Ovf IpAllocationParams.ip_allocation_policy.

For more information see: Vcenter Ovf IpAllocationParams IpAllocationScheme.

This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

array of string

supported_ip_allocation_policy

Optional

Specifies the IP allocation policies supported. The set of valid options for the policy is based on the capabilities of the virtual appliance software, as specified by the Vcenter Ovf IpAllocationParams.supported_allocation_scheme property.

For more information see: Vcenter Ovf IpAllocationParams IpAllocationPolicy.

This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

string

ip_allocation_policy

Optional

Specifies how IP allocation is done through an IP Pool. This is typically specified by the deployer.

For more information see: Vcenter Ovf IpAllocationParams IpAllocationPolicy.

This property is optional in the input parameters when deploying an OVF package. If missing or null there is no IP allocation policy. This property will always be present in the result when retrieving information about an OVF package.

array of string

supported_ip_protocol

Optional

Specifies the IP protocols supported by the guest.

For more information see: Vcenter Ovf IpAllocationParams IpProtocol.

This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

string

ip_protocol

Optional

Specifies the chosen IP protocol for this deployment. This must be one of the IP protocols supported by the guest software. See Vcenter Ovf IpAllocationParams.supported_ip_protocol.

For more information see: Vcenter Ovf IpAllocationParams IpProtocol.

This property is optional in the input parameters when deploying an OVF package. If missing or null there is no IP protocol chosen. This property will always be present in the result when retrieving information about an OVF package.

string

type

Optional

Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters schema.

This property must be provided in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.